home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / sox-11.12 / README < prev    next >
Text File  |  1995-07-13  |  8KB  |  210 lines
  1.  
  2.  
  3.         ST: Sound Tools
  4.  
  5.  
  6.  
  7. ST translates sound samples between different file formats,
  8. and performs various sound effects.
  9.  
  10. This release understands "raw" files in various binary formats,
  11. raw textual data, Microsoft Windows .WAV files, MAUD files,
  12. Sound Blaster .VOC files, IRCAM SoundFile files, SUN 
  13. Sparcstation .au files, mutant DEC .au files, Apple/SGI AIFF files, 
  14. CD-R (music CD format), Macintosh HCOM files, Sounder files, 
  15. NeXT .snd files, SUN ADPCM (compressed) .au files,
  16. Soundtool (DOS) files, and Psion (palmtop) A-law files.
  17.  
  18. The sound effects include changing the sample rate, adding echo 
  19. delay lines, applying low-, high, and band-pass filtering, 
  20. examining sample loops and grabbing the looped parts, xlating
  21. between stereo and monophonic channels nicely,
  22. reversing a sample in order to search for Satanic messages,
  23. adding masking noise to avoid buzzing voices, and the infamous 
  24. Fender Vibro effect.
  25.  
  26. Big news!  The 'resample' effect does high-grade signal rate
  27. changes using real signal theory.  Yes, it's very slow.
  28.  
  29. More big news!  Sample loops are now supported in a few
  30. file formats: SMP and AIFF.  WAV needs it.  I don't know
  31. what other formats actually know about sampler notes & loops.
  32. (To make a loop, you need a waveform editor that knows about
  33. them and has special features.  I do it on a Mac.)
  34.  
  35. Even more big news!  SOX now has full translation for stereo
  36. and mono sound files with a revamped 'avg' and the new 'pick' 
  37. and 'split' effects.
  38.  
  39. History:
  40. This is the 11th release of the Sound Tools.  Patchlevel 12.
  41. All previous releases went out on alt.sources.  This one should
  42. go out on comp.sources.misc, if all goes well.
  43.  
  44. There is a nice graphical front-end for the NeXT
  45. called GISO.  Check the comp.sys.next group
  46. or poke around the NeXT binary sites.  Also
  47. someone has done an OS/2 port.
  48.  
  49. Caveats:
  50. SOX is intended as the Swiss Army knife of sound
  51. processing tools.  It doesn't do anything very well,
  52. but sooner or later it comes in very handy.
  53. SOX is really only useable day-to-day if you
  54. hide the wacky options with one-line shell scripts.
  55.  
  56. Channel averaging doesn't work.  The software architecture
  57. of stereo & quad is bogus.
  58.  
  59. Installing:
  60. Use the DOS, Unix, Amiga, OS2, or OS9 Makefile as appropriate.
  61. The Makefile needs one option set: -DSYSV if you're on a
  62. System V machine, or -DBSD if you're on a BSD-ish machine.
  63. See the INSTALL file for more detailed instructions.
  64. There are three DOS Makefiles: Makefile.bor for pre-3.0 
  65. Borland C, Makefile.b30 for Borland 3.0, and Makefile.c70
  66. for Microsoft C 7.0.  OS2 needs the two OS2 Makefile-type
  67. programs.  OS9 needs Makefile.os9 for Microware Ultra C.
  68. Amiga needs the Amiga stuff.  Archimedes needs the .arc stuff
  69. and Setup.  The latter probably needs work.
  70.  
  71. After compiling, run 'tests.sh'.  It should print nothing.  This
  72. indicates that data is copied correctly.  By reading the tests
  73. you may see how to make a sound sample file which you can play.
  74. 'monkey.au' and 'monkey.voc' are a short lo-fi monkey screech
  75. in two supported file formats, to help you ensure that Sound 
  76. Tools works.  Note: 'tests.sh' works only under the Unix sh(1) 
  77. shell.  Use 'tests.com' under VMS.
  78.  
  79. Then, run 'testall.sh'.  This copies monkey.voc into all other
  80. supported file formats, making files in /tmp.  Then, it
  81. translates those formats back into .voc format.  This
  82. ensures (slightly) that all of the readers & writers don't 
  83. core-dump.
  84.  
  85. Now, read TIPS and CHEAT.  These give a background on how
  86. SOX deals with sound files and how to convert this format
  87. to that format, with examples for the most popular formats.
  88.  
  89. SOX uses file suffices to determine the nature of a sound sample file.
  90. If it finds the suffix in its list, it uses the appropriate read
  91. or write handler to deal with that file.  You may override the suffix
  92. by giving a different type via the '-t type' argument.  See the manual
  93. page for more information.  The 'tests.sh' script illustrates various
  94. sox usages.
  95.  
  96. SOX has an auto-detect feature that attempts to figure out
  97. the nature of an unmarked sound sample.  It works very well.
  98. This is the 'auto' file format.
  99.  
  100. I hope to inspire the creation of a common base of sound processing
  101. tools for computer multimedia work, similar to the PBM toolkit for 
  102. image manipulation.
  103.  
  104. Sound Tools may be used for any purpose.  Source
  105. distributions must include the copyright notices.  Binary
  106. distributions must include acknowledgements to the creators.
  107. The files I wrote are copyright Lance Norskog.
  108. The contributed files are copyright by their respective authors.
  109.  
  110. When you have minor changes to contribute, it's OK to post
  111. them; if you have a major release, please send it to me.
  112. I'd like to coordinate the releases and do a peer review.
  113. Please document your changes.  I don't possess every kind
  114. of computer currently sold, and SOX is now beyond the phase
  115. where I can understand and test most of your contributions.
  116. Please make your diff files such that your changes are 
  117. set off with ifdefs, and document them.  
  118.  
  119. Please DO NOT reformat the source code with your favorite 
  120. C beautifier, make 10 fixes, and send me the resulting release.
  121. I do not have the time to fish through 10000 diffs to find 
  122. your 10 fixes.
  123.  
  124. Note: There will be absolutely no more hardware driver
  125. handlers in SOX.  Playing & recording sound samples is
  126. not SOX's job; translation and sound effects is it.
  127. If you wish to write a separate main program (like sox.c)
  128. which uses the SoundTools library and records or plays
  129. on your machine, that's great and I'll be happy to
  130. include it.
  131.  
  132. The majority of SOX features and source code are contributed
  133. by you the user.  Thank you very much for making SOX
  134. a success!
  135.  
  136.     Creator & Maintainer:
  137.         Lance Norskog        thinman@netcom.com
  138.  
  139.     Contributors:
  140.         Guido Van Rossum    guido@cwi.nl
  141.             AU, AIFF, AUTO, HCOM, reverse,
  142.             many bug fixes
  143.         Jef Poskanzer        jef@well.sf.ca.us
  144.             original code for u-law and delay line
  145.         Bill Neisius        bill%solaria@hac2arpa.hac.com 
  146.             DOS port, 8SVX, Sounder, Soundtool formats
  147.             Apollo fixes, stat with auto-picker
  148.         Rick Richardson        rick@digibd.com
  149.             WAV and SB driver handlers, fixes
  150.         David Champion        dgc3@midway.uchicago.edu
  151.             Amiga port 
  152.         Pace Willisson        pace@blitz.com
  153.             Fixes for ESIX
  154.         Leigh Smith        leigh@psychok.dialix.oz.au
  155.             SMP and comment movement support.
  156.         David Sanderson        dws@ssec.wisc.edu
  157.             AIX3.1 fixes
  158.             (Note that to my knowledge AIX on RS/6000s has
  159.             NO SUPPORT for playing any sort of sound file,
  160.             so please don't write to me any more to ask
  161.             "how do I play sound files on my AIX box".  I
  162.             ported sox to AIX solely to use it to translate
  163.             between sound file formats.)
  164.         Glenn Lewis        glewis@pcocd2.intel.com
  165.             AIFF chunking fixes
  166.         Brian Campbell        brianc@quantum.qnx.com
  167.             QNX port and 16-bit fixes
  168.         Chris Adams        gt8741@prism.gatech.edu
  169.             DOS port fixes
  170.         John Kohl        jtkohl@kolvir.elcr.ca.us
  171.             BSD386 port, VOC stereo support
  172.         Ken Kubo        ken@hmcvax.claremont.edu
  173.             VMS port, VOC stereo support
  174.         Frank Gadegast         <phade@cs.tu-berlin.de>
  175.             Microsoft C 7.0 & C Borland 3.0 ports
  176.         David Elliot        <dce@scmc.sony.com>
  177.             CD-R format support
  178.         David Sears        <dns@essnj3.essnjay.com>
  179.             Linux support
  180.         Tom Littlejohn          <tlit@seq1.loc.gov>
  181.             Raw textual data
  182.         Boisy G. Pitre         boisy@microware.com
  183.             OS9 port
  184.                 Sun Microsystems, Guido Van Rossum
  185.                 CCITT G.711, G.721, G.723 implementation
  186.         Graeme Gill        graeme@labtam.labtam.oz.au
  187.             A-LAW format, Good .WAV handling,
  188.             avg channel expansion
  189.         Allen Grider        grider@hfsi.hfsi.com
  190.             VOC stereo mode, WAV file handling
  191.         Michel Fingerhut     Michel.Fingerhut@ircam.fr
  192.             Upgrade 'sf' format to current IRCAM format.
  193.             Float file support.
  194.         Chris Knight
  195.             Achimedes Acorn support
  196.         Richard Caley         R.Caley@ed.ac.uk
  197.             Psion WVE handler
  198.         Lutz Vieweg        lkv@mania.RoBIN.de
  199.             MAUD (Amiga) file handler
  200.         Tim Gardner        timg@tpi.com
  201.             Windows NT port for V7
  202.         Jimen Ching         jiching@wiliki.eng.hawaii.edu
  203.             Libst porting bugs
  204.         Lauren Weinstein    lauren@vortex.com
  205.             DOS porting, scripts, professional use
  206.         (your name could be here, too)
  207.         (I've probably lost a few, and several people fixed
  208.          the same bugs.)
  209.  
  210.